home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / x2ftp / msdos / source / snip9503 / x00api.h < prev    next >
C/C++ Source or Header  |  1995-03-14  |  8KB  |  241 lines
  1. /*
  2.  *  X00API.H - X00 FOSSIL driver HLLAPI
  3.  *   
  4.  *   Created by R.F. Pels.
  5.  *   modified by Bob Stout
  6.  *   Placed in the public domain by R.F. Pels.
  7.  */
  8.  
  9. #ifndef __X00API_H                        /*  Prevent double inclusion  */
  10. #define __X00API_H
  11.  
  12. /*  FOSSIL specifics */
  13.  
  14. #define X00_VECTOR          0x14
  15. #define X00_IDOFFSET        6
  16.  
  17. #if defined(__TURBOC__) || defined(__POWERC)
  18.  #define _far far
  19. #endif
  20.  
  21. /*  FOSSIL function request codes */
  22.  
  23. #define SET_BAUDRATE        0x0000
  24. #define TX_CHAR             0x0100
  25. #define RX_CHAR             0x0200
  26. #define STATUS              0x0300
  27. #define INITIALIZE          0x0400
  28. #define DEINITIALIZE        0x0500
  29. #define RAISE_DTR           0x0601
  30. #define LOWER_DTR           0x0600
  31. #define GET_SYS_INFO        0x0700
  32. #define FLUSH_OUTPUT        0x0800
  33. #define PURGE_OUTPUT        0x0900
  34. #define PURGE_INPUT         0x0A00
  35. #define TX_CHAR_NOWAIT      0x0B00
  36. #define PEEK_AHEAD_INPUT    0x0C00
  37. #define PEEK_AHEAD_KBD      0x0D00
  38. #define READ_KBD            0x0E00
  39. #define FLOW_CONTROL        0x0F00
  40. #define CTLC_CTLK_CHECK     0x1000
  41. #define SET_CUP             0x1100
  42. #define GET_CUP             0x1200
  43. #define WRITE_ANSI_CHAR     0x1300
  44. #define ENABLE_WATCHDOG     0x1401
  45. #define DISABLE_WATCHDOG    0x1400
  46. #define WRITE_BIOS_CHAR     0x1500
  47. #define INSERT_TICK_FUNC    0x1601
  48. #define DELETE_TICK_FUNC    0x1600
  49. #define BOOT_MACHINE        0x1700
  50. #define READ_BLOCK          0x1800
  51. #define WRITE_BLOCK         0x1900
  52. #define START_BREAK_SIGNAL  0x1A01
  53. #define STOP_BREAK_SIGNAL   0x1A00
  54. #define GET_DRIVER_INFO     0x1B00
  55. #define INSTALL_APPENDAGE   0x7e00
  56. #define REMOVE_APPENDAGE    0x7f00
  57.  
  58. /* port numbers and variable type of portnumber in calls */
  59.  
  60. #define PORTCOM1            0
  61. #define PORTCOM2            1
  62. #define PORTCOM3            2
  63. #define PORTCOM4            3
  64. #define PORTCOM5            4
  65. #define PORTCOM6            5
  66. #define PORTCOM7            6
  67. #define PORTCOM8            7
  68. #define PORTSPECIAL         0x00ff
  69.  
  70. typedef unsigned int PORT;
  71.  
  72. /* defines components of baud settings call */
  73.  
  74. #define BAUD300             0x40
  75. #define BAUD600             0x60
  76. #define BAUD1200            0x80
  77. #define BAUD2400            0xa0
  78. #define BAUD4800            0xc0
  79. #define BAUD9600            0xe0
  80. #define BAUD19200           0x00
  81. #define BAUD38400           0x20
  82. #define PARITYNONE          0x00
  83. #define PARITYODD           0x08
  84. #define PARITYNONEALT       0x10
  85. #define PARITYEVEN          0x18
  86. #define STOP1BIT            0x00
  87. #define STOP2BIT            0x04
  88. #define WORD5BIT            0x00
  89. #define WORD6BIT            0x01
  90. #define WORD7BIT            0x02
  91. #define WORD8BIT            0x03
  92. #define FIDOSETTING         PARITYNONE | STOP1BIT | WORD8BIT
  93. #define OPUSSETTING         PARITYNONE | STOP1BIT | WORD8BIT
  94. #define SEADOGSETTING       PARITYNONE | STOP1BIT | WORD8BIT
  95.  
  96. /* Error numbers */
  97.  
  98. #define X00_OK              0
  99. #define X00_NOT_HERE        100
  100. #define X00_CHAR_NOT_SENT   101
  101. #define X00_NO_INPUT        0xffff
  102. #define X00_NO_KEY          0xffff
  103. #define X00_INS_TICK        104
  104. #define X00_DEL_TICK        105
  105. #define X00_INS_APP         106
  106. #define X00_REM_APP         107
  107. #define X00_DTR_HIGH        108
  108. #define X00_DTR_LOW         109
  109.  
  110.  
  111. /* FOSSIL initcall result type */
  112.  
  113. #define X00_PRESENT         0x1954
  114.  
  115. typedef struct {
  116.         unsigned int result;
  117.         unsigned char max_function;
  118.         unsigned char revision;
  119.         } FOSSILINIT;
  120.  
  121. /* FOSSIL status return type: all fields are 1 if condition exists */
  122.  
  123. typedef union {
  124.         struct STATUSBITS {
  125.             unsigned                   : 3;
  126.             unsigned alwayshigh        : 1;
  127.             unsigned                   : 3;
  128.             unsigned carrier_detect    : 1;
  129.             unsigned chars_in_input    : 1;
  130.             unsigned input_overrun     : 1;
  131.             unsigned                   : 3;
  132.             unsigned output_not_full   : 1;
  133.             unsigned output_empty      : 1;
  134.             unsigned                   : 1;
  135.             } statusbits;
  136.       unsigned int statusword;
  137.       } FOSSILSTATUS;
  138.  
  139. /* FOSSIL info type */
  140.  
  141. typedef struct {
  142.         unsigned int  size;
  143.         unsigned char version;
  144.         unsigned char revision;
  145.         unsigned int  ofs_fossil_id;
  146.         unsigned int  seg_fossil_id;
  147.         unsigned int  input_size;
  148.         unsigned int  input_avail;
  149.         unsigned int  output_size;
  150.         unsigned int  output_avail;
  151.         unsigned char screen_width;
  152.         unsigned char screen_height;
  153.         unsigned char baud_rate_mask;
  154.         } FOSSILINFO;
  155.  
  156. /* FOSSIL system info type */
  157.  
  158. typedef struct {
  159.         unsigned char tick_number;
  160.         unsigned char ticks_per_second;
  161.         unsigned int  approx_ms_per_tick;
  162.         } FOSSILSYSINFO;
  163.  
  164. /* FOSSIL flow control type */
  165.  
  166. typedef union {
  167.         struct FLOWBITS {
  168.             unsigned  xonxoff         : 1;
  169.             unsigned  ctsrts          : 1;
  170.             unsigned  remote_xonxoff  : 1;
  171.             unsigned                  : 5;
  172.             } flowbits;
  173.       unsigned char flowword;
  174.       } FOSSILFLOWCTRL;
  175.  
  176. /* FOSSIL checks control type */
  177.  
  178. #define X00_CTLCK           0x0001
  179. #define X00_NO_CTLCK        0x0000
  180.  
  181. typedef union {
  182.         struct CHECKBITS {
  183.             unsigned  ctlc_ctlk         : 1;
  184.             unsigned  stop_transmitter  : 1;
  185.             unsigned                    : 6;
  186.             } checkbits;
  187.       unsigned char checkword;
  188.       } FOSSILCTLCCTLK;
  189.  
  190. #define COLDBOOT        0
  191. #define WARMBOOT        1
  192.  
  193. #if __cplusplus
  194.  extern "C" {
  195. #endif
  196.  
  197. unsigned int  x00_detect(void);
  198. FOSSILSTATUS  x00_set(unsigned char set, PORT port);
  199. FOSSILSTATUS  x00_tx_char(unsigned char c, PORT port);
  200. unsigned char x00_rx_char(PORT port);
  201. FOSSILSTATUS  x00_status(PORT port);
  202. FOSSILINIT    x00_init(PORT port, unsigned char _far *ctlc_flagbyte);
  203. void          x00_deinit(PORT port);
  204. unsigned int  x00_raise_dtr(PORT port);
  205. unsigned int  x00_lower_dtr(PORT port);
  206. FOSSILSYSINFO x00_sysinfo(void);
  207. void          x00_flush_output(PORT port);
  208. void          x00_purge_output(PORT port);
  209. void          x00_purge_input(PORT port);
  210. unsigned int  x00_tx_char_nowait(unsigned char c, PORT port);
  211. unsigned int  x00_peek_ahead_input(PORT port);
  212. unsigned int  x00_peek_ahead_kbd(void);
  213. unsigned int  x00_read_kbd(void);
  214. void          x00_flow_control(FOSSILFLOWCTRL f, PORT port);
  215. unsigned int  x00_ctlc_ctlk_check(FOSSILCTLCCTLK c, PORT port);
  216. void          x00_set_cup(unsigned char row, unsigned char col);
  217. void          x00_get_cup(unsigned char *row, unsigned char *col);
  218. void          x00_write_ANSI_char(unsigned char c);
  219. void          x00_enable_watchdog(PORT port);
  220. void          x00_disable_watchdog(PORT port);
  221. void          x00_write_BIOS_char(unsigned char c);
  222. unsigned int  x00_insert_tick_func(void (_far *tickfunc)());
  223. unsigned int  x00_delete_tick_func(void (_far *tickfunc)());
  224. void          x00_boot_machine(unsigned int boottype);
  225. unsigned int  x00_read_block(unsigned int count, void _far *buf, PORT port);
  226. unsigned int  x00_write_block(unsigned int count, void _far *buf, 
  227. PORT port);
  228. void          x00_start_break_signal(PORT port);
  229. void          x00_stop_break_signal(PORT port);
  230. unsigned int  x00_get_driverinfo(void _far *buf, PORT port);
  231. unsigned int  x00_install_appendage(unsigned char appcode,
  232.                   void (_far *appfunc)());
  233. unsigned int  x00_remove_appendage(unsigned char appcode, 
  234.                   void (_far *appfunc)());
  235.  
  236. #if __cplusplus
  237.  }
  238. #endif
  239.  
  240. #endif /* __X00API_H */
  241.